Carbon


RemoveControlProperty

Header: Controls.h Carbon status: Supported

Removes a piece of data that has been previously associated with a control.

OSStatus RemoveControlProperty (
    ControlRef control, 
    OSType propertyCreator, 
    OSType propertyTag
);
control

A handle to the control whose associated data you wish to remove.

propertyCreator

Your program’s signature, as registered through Apple Developer Technical Support. If your program is of a type that would not normally have a signature (for example, a plug-in), you should still register and use a signature in this case, even though your program’s file may not have the same creator code as the signature that you register. The 'macs' property signature is reserved for the system and should not be used.

propertyTag

The application-defined code identifying the associated data.

function result

A result code.

DISCUSSION

Your application may dissociate data it has previously set with the SetControlProperty function by calling the RemoveControlProperty function.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.5 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)